//==========================================================================
// Copyright (c) 2000-2008,  Elastos, Inc.  All Rights Reserved.
//==========================================================================
/*
 * JFFS2 -- Journalling Flash File System, Version 2.
 *
 * Copyright (C) 2001-2003 Red Hat, Inc.
 *
 * Created by David Woodhouse <dwmw2@infradead.org>
 *
 * For licensing information, see the file 'LICENCE' in this directory.
 *
 * $Id: debug.h,v 1.5 2006/05/16 14:14:23 shijun Exp $
 *
 */
#ifndef _JFFS2_DEBUG_H_
#define _JFFS2_DEBUG_H_

#ifndef CONFIG_JFFS2_FS_DEBUG
#define CONFIG_JFFS2_FS_DEBUG 0
#endif

#if CONFIG_JFFS2_FS_DEBUG == 1
/* Enable "paranoia" checks and dumps */
#define JFFS2_DBG_PARANOIA_CHECKS
#define JFFS2_DBG_DUMPS
#define JFFS2_DBG_READINODE_MESSAGES
#define JFFS2_DBG_FRAGTREE_MESSAGES
#define JFFS2_DBG_DENTLIST_MESSAGES
#define JFFS2_DBG_NODEREF_MESSAGES
#define JFFS2_DBG_INOCACHE_MESSAGES
#endif

#if CONFIG_JFFS2_FS_DEBUG == 2
#define JFFS2_DBG_FRAGTREE2_MESSAGES
#endif

/* Enable JFFS2 sanity checks by default */
#define JFFS2_DBG_SANITY_CHECKS

/*
 * Dx() are mainly used for debugging messages, they must go away and be
 * superseded by nicer JFFS2_DBG_XXX() macros...
 */
#if CONFIG_JFFS2_FS_DEBUG > 0
#define D1(x) x
#else
#define D1(x)
#endif

#if CONFIG_JFFS2_FS_DEBUG > 1
#define D2(x) x
#else
#define D2(x)
#endif

#define printk kprintf

/* The prefixes of JFFS2 messages */
#define JFFS2_DBG_MSG_PREFIX "[JFFS2 DBG]"
#define JFFS2_ERR_MSG_PREFIX "JFFS2 error: "
#define JFFS2_WARN_MSG_PREFIX "JFFS2 warning: "
#define JFFS2_NOTICE_MSG_PREFIX "JFFS2 notice: "

#define KERN_EMERG              "<0>" // system is unusable
#define KERN_ALERT              "<1>" // action must be taken immediately
#define KERN_CRIT               "<2>" // critical conditions
#define KERN_ERR                "<3>" // error conditions
#define KERN_WARNING            "<4>" // warning conditions
#define KERN_NOTICE             "<5>" // normal but significant condition
#define KERN_INFO               "<6>" // informational
#define KERN_DEBUG              "<7>" // debug-level messages

#define JFFS2_ERR_LVL  KERN_ERR
#define JFFS2_WARN_LVL  KERN_WARNING
#define JFFS2_NOTICE_LVL KERN_NOTICE
#define JFFS2_DBG_LVL  KERN_DEBUG

#if defined(_INTEL) || defined(_EVC)
EXTERN_C int  CDECL vkprintf(const char *, va_list);
/* JFFS2 message macros */
void inline _jffs2_error_(char *fmt,...)
{
    va_list ap;

    va_start(ap, fmt);

    printk(JFFS2_ERR_LVL JFFS2_ERR_MSG_PREFIX ":");
    vkprintf(fmt, ap);

    va_end(ap);
}
#define JFFS2_ERROR _jffs2_error_

void inline _jffs2_warning_(char *fmt,...)
{
    va_list ap;

    va_start(ap, fmt);

    printk(JFFS2_WARN_LVL JFFS2_WARN_MSG_PREFIX ":");
    vkprintf(fmt, ap);

    va_end(ap);
}

#define JFFS2_WARNING _jffs2_warning_

void inline _jffs2_notice_(char *fmt,...)
{
    va_list ap;

    va_start(ap, fmt);

    printk(JFFS2_NOTICE_LVL JFFS2_NOTICE_MSG_PREFIX ":");
    vkprintf(fmt, ap);

    va_end(ap);
}

#define JFFS2_NOTICE _jffs2_notice_

void inline _jffs2_debug_(char *fmt,...)
{
    va_list ap;

    va_start(ap, fmt);

    printk(JFFS2_DBG_LVL JFFS2_DBG_MSG_PREFIX ":");
    vkprintf(fmt, ap);

    va_end(ap);
}

#define JFFS2_DEBUG _jffs2_debug_

/*
 * We split our debugging messages on several parts, depending on the JFFS2
 * subsystem the message belongs to.
 */

void inline PrintNothing(char *fmt,...)
{
}
/* Read inode debugging messages */
#ifdef JFFS2_DBG_READINODE_MESSAGES
#define JFFS2_DBG_READINODE JFFS2_DEBUG
#else
#define JFFS2_DBG_READINODE PrintNothing
#endif

/* Fragtree build debugging messages */
#ifdef JFFS2_DBG_FRAGTREE_MESSAGES
#define JFFS2_DBG_FRAGTREE JFFS2_DEBUG
#else
#define JFFS2_DBG_FRAGTREE PrintNothing
#endif

/* Directory entry list manilulation debugging messages */
#ifdef JFFS2_DBG_DENTLIST_MESSAGES
#define JFFS2_DBG_DENTLIST JFFS2_DEBUG
#else
#define JFFS2_DBG_DENTLIST PrintNothing
#endif
#ifdef JFFS2_DBG_FRAGTREE2_MESSAGES
#define JFFS2_DBG_FRAGTREE2 JFFS2_DEBUG
#else
#define JFFS2_DBG_FRAGTREE2 PrintNothing
#endif

/* Print the messages about manipulating node_refs */
#ifdef JFFS2_DBG_NODEREF_MESSAGES
#define JFFS2_DBG_NODEREF JFFS2_DEBUG
#else
#define JFFS2_DBG_NODEREF PrintNothing
#endif

/* Manipulations with the list of inodes (JFFS2 inocache) */
#ifdef JFFS2_DBG_INOCACHE_MESSAGES
#define JFFS2_DBG_INOCACHE JFFS2_DEBUG
#else
#define JFFS2_DBG_INOCACHE PrintNothing
#endif

/* Watch the object allocations */
#ifdef JFFS2_DBG_MEMALLOC_MESSAGES
#define JFFS2_DBG_MEMALLOC JFFS2_DEBUG
#else
#define JFFS2_DBG_MEMALLOC PrintNothing
#endif

#else /*defined(_INTEL) || defined(_EVC)*/

/* JFFS2 message macros */
#define JFFS2_ERROR(fmt, ...)      \
    do {        \
        printk(JFFS2_ERR_LVL JFFS2_ERR_MSG_PREFIX " %s: " \
                        fmt, __FUNCTION__, ##__VA_ARGS__); \
    } while(0)

#define JFFS2_WARNING(fmt, ...)      \
    do {        \
        printk(JFFS2_WARN_LVL JFFS2_WARN_MSG_PREFIX " %s: " \
                        fmt, __FUNCTION__, ##__VA_ARGS__); \
    } while(0)

#define JFFS2_NOTICE(fmt, ...)      \
    do {        \
        printk(JFFS2_NOTICE_LVL JFFS2_NOTICE_MSG_PREFIX " %s: " \
                        fmt, __FUNCTION__, ##__VA_ARGS__); \
    } while(0)

#define JFFS2_DEBUG(fmt, ...)      \
    do {        \
        printk(JFFS2_DBG_LVL JFFS2_DBG_MSG_PREFIX " %s: " \
                        fmt, __FUNCTION__, ##__VA_ARGS__); \
    } while(0)

/*
* We split our debugging messages on several parts, depending on the JFFS2
* subsystem the message belongs to.
*/
/* Read inode debugging messages */
#ifdef JFFS2_DBG_READINODE_MESSAGES
#define JFFS2_DBG_READINODE(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_READINODE(fmt, ...)
#endif

/* Fragtree build debugging messages */
#ifdef JFFS2_DBG_FRAGTREE_MESSAGES
#define JFFS2_DBG_FRAGTREE(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_FRAGTREE(fmt, ...)
#endif

/* Directory entry list manilulation debugging messages */
#ifdef JFFS2_DBG_DENTLIST_MESSAGES
#define JFFS2_DBG_DENTLIST(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_DENTLIST(fmt, ...)
#endif
#ifdef JFFS2_DBG_FRAGTREE2_MESSAGES
#define JFFS2_DBG_FRAGTREE2(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_FRAGTREE2(fmt, ...)
#endif

/* Print the messages about manipulating node_refs */
#ifdef JFFS2_DBG_NODEREF_MESSAGES
#define JFFS2_DBG_NODEREF(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_NODEREF(fmt, ...)
#endif

/* Manipulations with the list of inodes (JFFS2 inocache) */
#ifdef JFFS2_DBG_INOCACHE_MESSAGES
#define JFFS2_DBG_INOCACHE(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_INOCACHE(fmt, ...)
#endif

/* Watch the object allocations */
#ifdef JFFS2_DBG_MEMALLOC_MESSAGES
#define JFFS2_DBG_MEMALLOC(fmt, ...) JFFS2_DEBUG(fmt, ##__VA_ARGS__)
#else
#define JFFS2_DBG_MEMALLOC(fmt, ...)
#endif

#endif /*defined(_INTEL) || defined(_EVC)*/

/* "Paranoia" checks */
void
__jffs2_dbg_fragtree_paranoia_check(struct jffs2_inode_info *f);
void
__jffs2_dbg_fragtree_paranoia_check_nolock(struct jffs2_inode_info *f);
void
__jffs2_dbg_acct_paranoia_check(struct jffs2_sb_info *c,
                                struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_acct_paranoia_check_nolock(struct jffs2_sb_info *c,
                                       struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_prewrite_paranoia_check(struct jffs2_sb_info *c,
                                    uint32_t ofs, int len);

/* "Dump" functions */
void
__jffs2_dbg_dump_jeb(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_dump_jeb_nolock(struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_dump_block_lists(struct jffs2_sb_info *c);
void
__jffs2_dbg_dump_block_lists_nolock(struct jffs2_sb_info *c);
void
__jffs2_dbg_dump_node_refs(struct jffs2_sb_info *c,
                           struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_dump_node_refs_nolock(struct jffs2_sb_info *c,
                                  struct jffs2_eraseblock *jeb);
void
__jffs2_dbg_dump_fragtree(struct jffs2_inode_info *f);
void
__jffs2_dbg_dump_fragtree_nolock(struct jffs2_inode_info *f);
void
__jffs2_dbg_dump_buffer(unsigned char *buf, int len, uint32_t offs);
void
__jffs2_dbg_dump_node(struct jffs2_sb_info *c, uint32_t ofs);

#ifdef JFFS2_DBG_PARANOIA_CHECKS
#define jffs2_dbg_fragtree_paranoia_check(f)   \
    __jffs2_dbg_fragtree_paranoia_check(f)
#define jffs2_dbg_fragtree_paranoia_check_nolock(f)  \
    __jffs2_dbg_fragtree_paranoia_check_nolock(f)
#define jffs2_dbg_acct_paranoia_check(c, jeb)   \
    __jffs2_dbg_acct_paranoia_check(c,jeb)
#define jffs2_dbg_acct_paranoia_check_nolock(c, jeb)  \
    __jffs2_dbg_acct_paranoia_check_nolock(c,jeb)
#define jffs2_dbg_prewrite_paranoia_check(c, ofs, len)  \
    __jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
#else
#define jffs2_dbg_fragtree_paranoia_check(f)
#define jffs2_dbg_fragtree_paranoia_check_nolock(f)
#define jffs2_dbg_acct_paranoia_check(c, jeb)
#define jffs2_dbg_acct_paranoia_check_nolock(c, jeb)
#define jffs2_dbg_prewrite_paranoia_check(c, ofs, len)
#endif /* !JFFS2_PARANOIA_CHECKS */

#ifdef JFFS2_DBG_DUMPS
#define jffs2_dbg_dump_jeb(c, jeb)    \
    __jffs2_dbg_dump_jeb(c, jeb);
#define jffs2_dbg_dump_jeb_nolock(jeb)    \
    __jffs2_dbg_dump_jeb_nolock(jeb);
#define jffs2_dbg_dump_block_lists(c)    \
    __jffs2_dbg_dump_block_lists(c)
#define jffs2_dbg_dump_block_lists_nolock(c)   \
    __jffs2_dbg_dump_block_lists_nolock(c)
#define jffs2_dbg_dump_fragtree(f)    \
    __jffs2_dbg_dump_fragtree(f);
#define jffs2_dbg_dump_fragtree_nolock(f)   \
    __jffs2_dbg_dump_fragtree_nolock(f);
#define jffs2_dbg_dump_buffer(buf, len, offs)   \
    __jffs2_dbg_dump_buffer(*buf, len, offs);
#define jffs2_dbg_dump_node(c, ofs)    \
    __jffs2_dbg_dump_node(c, ofs);
#else
#define jffs2_dbg_dump_jeb(c, jeb)
#define jffs2_dbg_dump_jeb_nolock(jeb)
#define jffs2_dbg_dump_block_lists(c)
#define jffs2_dbg_dump_block_lists_nolock(c)
#define jffs2_dbg_dump_fragtree(f)
#define jffs2_dbg_dump_fragtree_nolock(f)
#define jffs2_dbg_dump_buffer(buf, len, offs)
#define jffs2_dbg_dump_node(c, ofs)
#endif /* !JFFS2_DBG_DUMPS */

/*
 * Sanity checks are supposed to be light-weight and enabled by default.
 */
#ifdef JFFS2_DBG_SANITY_CHECKS
/*
 * Check the space accounting of the file system and of
 * the JFFS2 erasable block 'jeb'.
 */
static inline void
jffs2_dbg_acct_sanity_check_nolock(struct jffs2_sb_info *c,
                struct jffs2_eraseblock *jeb)
{
    if (unlikely(jeb && jeb->used_size + jeb->dirty_size +
            jeb->free_size + jeb->wasted_size +
            jeb->unchecked_size != c->sector_size)) {
        JFFS2_ERROR("eeep, space accounting for block at 0x%08x is screwed.\n",
                        jeb->offset);
        JFFS2_ERROR("free %#08x + dirty %#08x + used %#08x + wasted %#08x +"
                        " unchecked %#08x != total %#08x.\n", jeb->free_size,
                        jeb->dirty_size, jeb->used_size, jeb->wasted_size,
                        jeb->unchecked_size, c->sector_size);
        BUG();
    }

    if (unlikely(c->used_size + c->dirty_size + c->free_size + c->erasing_size + c->bad_size
        + c->wasted_size + c->unchecked_size != c->flash_size)) {
        JFFS2_ERROR("eeep, space accounting superblock info is screwed.\n");
        JFFS2_ERROR("free %#08x + dirty %#08x + used %#08x + erasing %#08x + bad %#08x + "
                    "wasted %#08x + unchecked %#08x != total %#08x.\n",
                    c->free_size, c->dirty_size, c->used_size, c->erasing_size, c->bad_size,
                    c->wasted_size, c->unchecked_size, c->flash_size);
        BUG();
    }
}

static inline void
jffs2_dbg_acct_sanity_check(struct jffs2_sb_info *c,
                struct jffs2_eraseblock *jeb)
{
    spin_lock(&c->erase_completion_lock);
    jffs2_dbg_acct_sanity_check_nolock(c, jeb);
    spin_unlock(&c->erase_completion_lock);
}
#else
#define jffs2_dbg_acct_sanity_check(c, jeb)
#define jffs2_dbg_acct_sanity_check_nolock(c, jeb)
#endif /* !JFFS2_DBG_SANITY_CHECKS */

#endif /* _JFFS2_DEBUG_H_ */
